<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>TMFFFormat</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="TMFFFormat";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../mmj/tmff/TMFFFlat.html" title="class in mmj.tmff"><span class="strong">Prev Class</span></a></li>
<li><a href="../../mmj/tmff/TMFFMethod.html" title="class in mmj.tmff"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mmj/tmff/TMFFFormat.html" target="_top">Frames</a></li>
<li><a href="TMFFFormat.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">mmj.tmff</div>
<h2 title="Class TMFFFormat" class="title">Class TMFFFormat</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>mmj.tmff.TMFFFormat</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">TMFFFormat</span>
extends java.lang.Object</pre>
<div class="block">TMFFFormat holds an instantiated TMFFScheme and a format number assigned by
 the user.
 <p>
 In the future additional schemes might be assigned for Syntax Axiom level
 processing -- which is why TMFFFormat was created, though it seems redundant
 now.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../mmj/tmff/TMFFFormat.html#TMFFFormat()">TMFFFormat</a></strong>()</code>
<div class="block">Default constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../mmj/tmff/TMFFFormat.html#TMFFFormat(int, mmj.tmff.TMFFScheme)">TMFFFormat</a></strong>(int&nbsp;formatNbr,
          <a href="../../mmj/tmff/TMFFScheme.html" title="class in mmj.tmff">TMFFScheme</a>&nbsp;formatScheme)</code>
<div class="block">Standard constructor for TMFFFormat.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../mmj/tmff/TMFFFormat.html#TMFFFormat(java.lang.String[], mmj.tmff.TMFFPreferences)">TMFFFormat</a></strong>(java.lang.String[]&nbsp;param,
          <a href="../../mmj/tmff/TMFFPreferences.html" title="class in mmj.tmff">TMFFPreferences</a>&nbsp;tmffPreferences)</code>
<div class="block">Constructor for TMFFFormat using user parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../mmj/tmff/TMFFFormat.html#TMFFFormat(java.lang.String, mmj.tmff.TMFFScheme)">TMFFFormat</a></strong>(java.lang.String&nbsp;formatNbrString,
          <a href="../../mmj/tmff/TMFFScheme.html" title="class in mmj.tmff">TMFFScheme</a>&nbsp;formatScheme)</code>
<div class="block">Standard constructor for TMFFFormat.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../mmj/tmff/TMFFFormat.html#getFormatNbr()">getFormatNbr</a></strong>()</code>
<div class="block">Get the number assigned to this TMFFFormat.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../mmj/tmff/TMFFScheme.html" title="class in mmj.tmff">TMFFScheme</a></code></td>
<td class="colLast"><code><strong><a href="../../mmj/tmff/TMFFFormat.html#getFormatScheme()">getFormatScheme</a></strong>()</code>
<div class="block">Get the TMFFScheme instance assigned to this TMFFFormat.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mmj/tmff/TMFFFormat.html#setFormatNbr(int)">setFormatNbr</a></strong>(int&nbsp;formatNbr)</code>
<div class="block">Set Number assigned to this TMFFFormat.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mmj/tmff/TMFFFormat.html#setFormatScheme(mmj.tmff.TMFFScheme)">setFormatScheme</a></strong>(<a href="../../mmj/tmff/TMFFScheme.html" title="class in mmj.tmff">TMFFScheme</a>&nbsp;formatScheme)</code>
<div class="block">Set TMFFScheme assigned to this TMFFFormat.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../mmj/tmff/TMFFFormat.html#validateFormatNbr(int)">validateFormatNbr</a></strong>(int&nbsp;formatNbr)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../mmj/tmff/TMFFFormat.html#validateFormatNbr(java.lang.String)">validateFormatNbr</a></strong>(java.lang.String&nbsp;formatNbrString)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="TMFFFormat()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TMFFFormat</h4>
<pre>public&nbsp;TMFFFormat()</pre>
<div class="block">Default constructor.</div>
</li>
</ul>
<a name="TMFFFormat(java.lang.String[], mmj.tmff.TMFFPreferences)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TMFFFormat</h4>
<pre>public&nbsp;TMFFFormat(java.lang.String[]&nbsp;param,
          <a href="../../mmj/tmff/TMFFPreferences.html" title="class in mmj.tmff">TMFFPreferences</a>&nbsp;tmffPreferences)</pre>
<div class="block">Constructor for TMFFFormat using user parameters.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - String array of RunParm values.</dd><dd><code>tmffPreferences</code> - TMFFPreferences object.</dd></dl>
</li>
</ul>
<a name="TMFFFormat(java.lang.String, mmj.tmff.TMFFScheme)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TMFFFormat</h4>
<pre>public&nbsp;TMFFFormat(java.lang.String&nbsp;formatNbrString,
          <a href="../../mmj/tmff/TMFFScheme.html" title="class in mmj.tmff">TMFFScheme</a>&nbsp;formatScheme)</pre>
<div class="block">Standard constructor for TMFFFormat.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatNbrString</code> - number 1, 2, 3, etc., up to a predefined maximum
            value (presently 3). This number is used elsewhere to identify
            Formats.</dd><dd><code>formatScheme</code> - the instantiated TMFFScheme assigned to this format.</dd></dl>
</li>
</ul>
<a name="TMFFFormat(int, mmj.tmff.TMFFScheme)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TMFFFormat</h4>
<pre>public&nbsp;TMFFFormat(int&nbsp;formatNbr,
          <a href="../../mmj/tmff/TMFFScheme.html" title="class in mmj.tmff">TMFFScheme</a>&nbsp;formatScheme)</pre>
<div class="block">Standard constructor for TMFFFormat.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatNbr</code> - number 1, 2, 3, etc., up to a predefined maximum value
            (presently 3). This number is used elsewhere to identify
            Formats.</dd><dd><code>formatScheme</code> - the instantiated TMFFScheme assigned to this format.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="validateFormatNbr(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateFormatNbr</h4>
<pre>public static&nbsp;int&nbsp;validateFormatNbr(java.lang.String&nbsp;formatNbrString)</pre>
</li>
</ul>
<a name="validateFormatNbr(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateFormatNbr</h4>
<pre>public static&nbsp;int&nbsp;validateFormatNbr(int&nbsp;formatNbr)</pre>
</li>
</ul>
<a name="getFormatScheme()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormatScheme</h4>
<pre>public&nbsp;<a href="../../mmj/tmff/TMFFScheme.html" title="class in mmj.tmff">TMFFScheme</a>&nbsp;getFormatScheme()</pre>
<div class="block">Get the TMFFScheme instance assigned to this TMFFFormat.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>formatScheme instance.</dd></dl>
</li>
</ul>
<a name="setFormatScheme(mmj.tmff.TMFFScheme)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFormatScheme</h4>
<pre>public&nbsp;void&nbsp;setFormatScheme(<a href="../../mmj/tmff/TMFFScheme.html" title="class in mmj.tmff">TMFFScheme</a>&nbsp;formatScheme)</pre>
<div class="block">Set TMFFScheme assigned to this TMFFFormat.
 <p>
 Note: the Scheme for format number 0 cannot be updated, it is 'RESERVED'
 for 'Unformatted'.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatScheme</code> - pre-instantiated TMFFScheme.</dd></dl>
</li>
</ul>
<a name="getFormatNbr()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormatNbr</h4>
<pre>public&nbsp;int&nbsp;getFormatNbr()</pre>
<div class="block">Get the number assigned to this TMFFFormat.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>formatNbr string.</dd></dl>
</li>
</ul>
<a name="setFormatNbr(int)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setFormatNbr</h4>
<pre>public&nbsp;void&nbsp;setFormatNbr(int&nbsp;formatNbr)</pre>
<div class="block">Set Number assigned to this TMFFFormat.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatNbr</code> - non-null, non-empty String.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../mmj/tmff/TMFFFlat.html" title="class in mmj.tmff"><span class="strong">Prev Class</span></a></li>
<li><a href="../../mmj/tmff/TMFFMethod.html" title="class in mmj.tmff"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mmj/tmff/TMFFFormat.html" target="_top">Frames</a></li>
<li><a href="TMFFFormat.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
